Api.WriteOutputByte method

Writes a byte into an output of a real or simulated I/O module.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB
public KsError WriteOutputByte(
       int Index,
       int ByteOffset,
       byte Value
)
Public Function WriteOutputByte(
       Index As Integer,
       ByteOffset As Integer,
       Value As Byte
) As KsError

Parameters

Index

Type: int

The index of an I/O module. Indexes are zero based. Aliases affect this parameter.

 

ByteOffset

Type: int

Specifies a byte offset to the location to write a byte value. The max offset is determined by OutputLength in the SlaveStatus class.

 

Value

Type: byte

A byte value to write.

Return value

Type: KsError

A return code of a method.

Remarks

WriteOutputByte can only be called once a link is established and started.

Usable EtherCAT states

ecatOP

Examples

C#
N/A

See also

Api Class

IntervalZero.KINGSTAR.Local.Api Namespace